On This Page {#jumplink-list} [Markdown](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns.md) Filter FILTER BY TAG Payment Transactions {#sa-payment-txns} ======================================= This section provides endpoints and transaction use cases. Endpoints and Transaction Types {#sa-endpoints-txn-types} ========================================================= |-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Create Payment Token Endpoints** See [Creating a Payment Card Token](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-payment-tokens-reseller/sa-create-payment-card-token.md ""). || | Test | `https://testsecureacceptance.cybersource.com/silent/token/create` | | Production | `https://secureacceptance.cybersource.com/silent/token/create` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/token/create` | | Supported transaction type | `create_payment_token` | | **Iframe Create Payment Token Endpoints** See [Iframe Implementation](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-iframe-implementation.md ""). || | Test | `https://testsecureacceptance.cybersource.com/silent/embedded/token/create` | | Production | `https://secureacceptance.cybersource.com/silent/embedded/token/create` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/embedded/token/create` | | Supported transaction type | `create_payment_token` | | **Iframe Transaction Endpoints** See [Iframe Implementation](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-iframe-implementation.md ""). || | Test | `https://testsecureacceptance.cybersource.com/silent/embedded/pay` | | Production | `https://secureacceptance.cybersource.com/silent/embedded/pay` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/embedded/pay` | | Supported transaction type | * `authorization` * `authorization,create_payment_token` * `authorization,update_payment_token` * `sale` * `sale,create_payment_token` * `sale,update_payment_token` * `create_payment_token` | | **Iframe Update Payment Token Endpoints** See [Iframe Implementation](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-iframe-implementation.md ""). || | Test | `https://testsecureacceptance.cybersource.com/silent/embedded/token/update` | | Production | `https://secureacceptance.cybersource.com/silent/embedded/token/update` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/embedded/token/update` | | Supported transaction type | `update_payment_token` | | **Process Transaction Endpoints** || | Test | `https://testsecureacceptance.cybersource.com/silent/pay` | | Production | `https://secureacceptance.cybersource.com/silent/pay` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/pay` | | Supported transaction types | * `authorization` * `authorization,create_payment_token` * `authorization,update_payment_token` * `sale` * `sale,create_payment_token` * `sale,update_payment_token` | | **Update Payment Token Endpoints** See [Payment Token Updates](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-payment-token-updates.md ""). || | Test | `https://testsecureacceptance.cybersource.com/silent/token/update` | | Production | `https://secureacceptance.cybersource.com/silent/token/update` | | Production in India | `https://secureacceptance.in.cybersource.com/silent/token/update` | | Supported transaction type | `update_payment_token` | [Endpoints] Required Signed Fields {#sa-required-signed-fields} =================================================== Signing fields protects them from malicious actors adding or changing transaction data during transmission. To sign fields, include them in a comma-separated string in the signed_field_names field in your request. To prevent data tampering, include all request fields in the signed_field_names field with the exception of the card_number , card_cvn , and signature . These signed fields are required in all `Secure Acceptance` requests: * access_key * amount * currency * locale * payment_method * profile_id * reference_number * signed_date_time * signed_field_names * transaction_type * transaction_uuid * unsigned_field_names For descriptions of these fields, see [Request Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields/sa-request-fields.md ""). Payment Tokens {#sa-payment-tokens-reseller} ============================================ Creating a Payment Card Token {#sa-create-payment-card-token} ============================================================= Include the appropriate endpoint that supports the ` create_payment_token ` transaction type. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields. See [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). Include all request fields in the signed_field_names field with the exception of the card_number, card_cvn, and signature fields. The signed_field_names field is used to generate a signature that is used to verify the content of the transaction in order to prevent data tampering. Example: Creating a Standalone Payment Card Token **Request** ``` reference_number=12x456789 // Replace X with 3 transaction_type=create_payment_token currency=usd amount=100.00 locale=en access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p3 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 transaction_uuid=02815b4f08e56882751a043839b7b481 signed_date_time=2020-07-11T15:16:54Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= payment_method=card card_type=001 card_number=411111111111xxxx // Replace x with 1 card_expiry_date=12-2022 card_cvn=005 bill_to_forename=Joe bill_to_surname=Smith bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_city=Mountain View bill_to_address_postal_code=94043 bill_to_address_state=CA bill_to_address_country=US ``` **Response** ``` req_reference_number=12x456789 // Replace X with 3 req_transaction_type=create_payment_token req_locale=en req_amount=100.00 req_payment_method=card req_card_type=001 req_card_number=xxxxxxxxxxxx1111 req_card_expiry_date=12-2022 req_bill_to_forename=Joe req_bill_to_surname=Smith req_bill_to_email=joesmith@example.com req_bill_to_address_line1=1 My Apartment req_bill_to_address_city=Mountain View req_bill_to_address_postal_code=94043 req_bill_to_address_state=CA req_bill_to_address_country=US req_access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p3 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_transaction_uuid=02815b4f08e56882751a043839b7b481 signed_date_time=2020-07-11T15:16:54Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= decision=ACCEPT reason_code=100 transaction_id=3735553783662130706689 req_payment_token=CF2194C8A0F545CDE053AF598E0A20DA ``` Creating an ACH Token {#sa-create-echeck-token} =============================================== Include the appropriate endpoint that supports the ` create_payment_token ` transaction type. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields, see [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). Include all request fields in the signed_field_names field. The signed_field_names field is used to generate a signature that is used to verify the content of the transaction in order to prevent data tampering. Example: Creating a Standalone ACH Payment Token **Request** ``` access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p1 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 transaction_type=create_payment_token currency=USD amount=100.00 locale=en reference_number=1730560013735542024294683 transaction_uuid=02815b4f08e56882751a043839b7b481 signed_date_time=2022-07-11T15:16:54Z signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields bill_to_forename=Joe bill_to_surname=Smith bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_state=CA bill_to_postal_code=94043 bill_to_address_country=US payment_method=echeck driver_license_state=NY driver_license_number=X4-782X9-X96 // Replace X with 3 date_of_birth=19901001 echeck_account_type=c company_tax_id=12x456789 // Replace X with 3 echeck_sec_code=WEB echeck_account_number=4528941xx // Replace x with 0 echeck_routing_number=6723x2882 // Replace x with 0 ``` **Response** ``` req_bill_to_address_country=US req_driver_license_state=NY req_driver_license_number=xx-xxxxx-xxx req_date_of_birth=19901001 decision=ACCEPT req_amount=100.00 req_bill_to_address_state=CA signed_field_names=reference_number,transaction_type,currency,amount,locale,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,etc... req_payment_method=echeck req_transaction_type=create_payment_token req_echeck_account_type=c signature=NuxlJilx5YbvKoXlt0baB5hUj5gk4+OozqJnyVF390s= req_locale=en reason_code=100 req_bill_to_address_postal_code=94043 req_echeck_account_number=xxxxx4100 req_bill_to_address_line1=1 My Apartment req_echeck_sec_code=WEB req_bill_to_address_city=San Francisco signed_date_time=2022-07-11T15:11:41Z req_currency=USD req_reference_number=1730560013735542024294683 req_echeck_routing_number=xxxxx2882 transaction_id=3735553783662130706689 req_amount=100.00 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_company_tax_id=12x456789 // Replace X with 3 req_transaction_uuid=38f2efe650ea699597d325ecd7432b1c req_payment_token=CF2194C8A0F545CDE053AF598E0A20DA req_bill_to_surname=Soap req_bill_to_forename=Joe req_bill_to_email=joesoap@yahoo.com req_access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p1 ``` Payment Token Transactions {#sa-payment-token-txns} =================================================== To create a single-click checkout experience for returning customers, send the payment token instead of the payment data to the transaction endpoints. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). Requesting a Payment Card Transaction with a Token {#sa-checkout-req-card-trxn-token} ===================================================================================== Include the appropriate endpoint that supports the authorization or sale transaction types. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields, see [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). The **payment_token** field identifies the card and retrieves the associated billing, shipping, and payment information. Payment Card Transaction with a Token **Request** ``` access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 reference_number=1350029885978 payment_token=CF2194C8A0F545CDE053AF598E0A20DA consumer_id=1239874561 transaction_type=authorization amount=100.00 currency=USD payment_method=card locale=en transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2020-01-17T10:46:39Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= ``` **Response** ``` transaction_id=3500311655560181552946 decision=ACCEPT message=Request was processed successfully. req_access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_transaction_uuid=55d895790bc4c8a0f4464f9426ba3b79 req_transaction_type=authorization req_reference_number=1350029885978 req_amount=100.00 req_tax_amount=15.00 req_currency=USD req_locale=en req_payment_method=card req_consumer_id=1239874561 req_bill_to_forename=Joe req_bill_to_surname=Smith req_bill_to_email=jsmith@example.com req_bill_to_address_line1=1 My Apartment req_bill_to_address_state=CA req_bill_to_address_country=US req_card_number=xxxxxxxxxxxx4242 req_card_type=001 req_card_expiry_date=11-2020 reason_code=100 auth_avs_code=U auth_avs_code_raw=00 auth_response=0 auth_amount=100.00 auth_time==2022-08-14T134608Z req_payment_token=CF2194C8A0F545CDE053AF598E0A20DA signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... signed_date_time=2022-10-12T08:39:25Z signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= payment_token_latest_card_suffix=1717 payment_token_latest_card_expiry_date=11-2024 payment_solution=015 ``` ACH Payment with a Token {#sa-request-echeck-txn-with-token} ============================================================ Include the appropriate endpoint that supports the ` authorization ` or ` sale ` transaction types. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields, see [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). The payment_token field identifies the bank account and retrieves the associated billing, shipping, and payment information. Example: Processing a Payment with an ACH Token **Request** ``` access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p3 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 reference_number=1845864013783060468573616 transaction_type=sale currency=USD amount=100.00 locale=en payment_method=echeck payment_token=CF2194C8A0F545CDE053AF598E0A20DA transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2022-01-17T10:46:39Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= ``` **Response** ``` req_bill_to_address_country=US req_driver_license_state=NY req_driver_license_number=xx-xxxxx-xxx req_date_of_birth=19901001 decision=ACCEPT req_bill_to_address_state=CA signed_field_names=reference_number,transaction_type,currency,amount,locale,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,etc... req_payment_method=echeck req_transaction_type=sale req_echeck_account_type=c signature=ZUk7d99c/yb+kidvVUbz10JtykmjOt8LMPgkllRaZR8= req_locale=en reason_code=100 req_echeck_account_number=xxxxx4100 req_bill_to_address_line1=1 My Apartment req_echeck_sec_code=WEB signed_date_time=2022-06-12T09:59:50Z req_currency=USD req_reference_number=77353001371031080772693 req_echeck_routing_number=xxxxx2882 transaction_id=3710311877042130706689 req_amount=100.00 message=Request was processed successfully. echeck_debit_ref_no=1 echeck_debit_submit_time=2022-03-25T104341Z req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_company_tax_id=12x456789 // Replace X with 3 req_transaction_uuid=bdc596506c2677b79133c9705e5cf77c req_bill_to_surname=Smith req_bill_to_forename=Joe req_bill_to_email=jsmith@example.com req_access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 ``` Recurring Payments {#sa-recurring-payments} =========================================== Your merchant ID must be enabled to process recurring payments. You must specify the amount and frequency of each payment and the start date for processing recurring payments. `Cybersource` creates a schedule based on this information and automatically bills the customer according to the schedule. > Include the appropriate endpoint that supports the ` authorization,create_payment_token ` or ` sale,create_payment_token ` transaction types. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields, see [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). > The amount field is an optional field that indicates the setup fee for processing recurring payments. > Example: Creating a Recurring Billing Payment and Token > **Request** ``` access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 transaction_type=authorization,create_payment_token locale=en amount=5.00 transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2020-01-17T10:46:39Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= consumer_id=x23987456x // Replace x with 1 bill_to_forename=Joe bill_to_surname=Smith bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_state=CA bill_to_address_country=US card_type=001 card_number=411111111111xxxx // Replace x with 1 card_expiry_date=12-2022 card_cvn=005 transaction_reason=setup_recurring recurring_frequency=monthly recurring_amount=25.00 recurring_start_date=20200125 payment_method=card ``` **Response** ``` transaction_id=3500311655560181552946 decision=ACCEPT message=Request was processed successfully. req_access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_transaction_uuid=55d895790bc4c8a0f4464f9426ba3b79 req_transaction_type=authorization,create_payment_token req_reference_number=1350029885978 req_amount=5.00 req_tax_amount=2.50 req_currency=USD req_locale=en req_payment_method=card req_consumer_id=x23987456x // Replace x with 1 req_recurring_frequency=monthly req_recurring_amount=25.00 req_recurring_start_date=20200125 req_bill_to_forename=Joe req_bill_to_surname=Smith req_bill_to_email=joesmith@example.com req_bill_to_address_line1=1 My Apartment req_bill_to_address_state=CA req_bill_to_address_country=US req_card_number=xxxxxxxxxxxx1111 req_card_type=001 req_card_expiry_date=12-2022 reason_code=100 auth_avs_code=U auth_avs_code_raw=00 auth_response=0 auth_amount=100.00 auth_time=2022-08-14T134608Z req_payment_token=CF2194C8A0F545CDE053AF598E0A20DA signed_field_names=reference_number,transaction_type,currency,amount,locale,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,etc... signed_date_time=2022-10-12T08:39:25Z signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= ``` Installment Payments {#sa-installment-payments} =============================================== Your merchant ID must be enabled to process installment payments. You must specify the number of payments, the amount and frequency of each payment, and the start date for processing the payments. `Cybersource` creates a schedule based on this information and automatically bills the customer according to the schedule. > Include the appropriate endpoint that supports the ` authorization,create_payment_token ` or ` sale,create_payment_token ` transaction types. See [Endpoints and Transaction Types](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-payment-txns/sa-endpoints-txn-types.md ""). For descriptions of all request and response fields, see [Checkout API Fields](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-wm-api-fields.md ""). > The amount field is an optional field that indicates the setup fee for processing recurring payments. To charge this fee, include the amount field and ensure that the transaction_type field is set to ` authorization,create_payment_token ` or ` sale,create_payment_token `. > Example: Creating an Installment Payment and Token > **Request** ``` access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 transaction_type=authorization,create_payment_token amount=5.00 locale=en transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2020-01-17T10:46:39Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= consumer_id=x23987456x // Replace x with 1 bill_to_forename=Joe bill_to_surname=Smith
bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_state=CA bill_to_address_country=US card_type=001 card_number=411111111111xxxx // Replace x with 1 card_expiry_date=12-2022 card_cvn=005 recurring_frequency=monthly recurring_number_of_installments=6 recurring_amount=25.00 recurring_start_date=20200125 payment_method=card ``` **Response** ``` transaction_id=3500311655560181552946 decision=ACCEPT message=Request was processed successfully. req_access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_transaction_uuid=55d895790bc4c8a0f4464f9426ba3b79 req_transaction_type=authorization,create_payment_token req_reference_number=1350029885978 req_amount=5.00 req_currency=USD req_locale=en req_payment_method=card req_consumer_id=x23987456x // Replace x with 1 req_recurring_frequency=monthly req_recurring_number_of_installments=6 req_recurring_amount=25.00 req_recurring_start_date=20200125 req_bill_to_forename=Joe req_bill_to_surname=Smith req_bill_to_email=joesmith@example.com req_bill_to_address_line1=1 My Apartment req_bill_to_address_state=CA req_bill_to_address_country=US req_card_number=xxxxxxxxxxxx1111 req_card_type=001 req_card_expiry_date=12-2022 reason_code=100 auth_avs_code=U auth_avs_code_raw=00 auth_response=0 auth_amount=100.00 auth_time==2022-08-14T134608Z req_payment_token=CF2194C8A0F545CDE053AF598E0A20DA signed_field_names=reference_number,transaction_type,currency,amount,locale,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,etc... signed_date_time=2022-10-12T08:39:25Z signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= ``` Payment Token Updates {#sa-payment-token-updates} ================================================= Updating a Payment Card Token {#sa-update-payment-card-token} ============================================================= The payment_token field identifies the card and retrieves the associated billing, shipping, and payment information. > Include the endpoint that supports ` update_payment_token ` or the endpoint that supports ` authorization,update_payment_token ` (updates the token and authorizes the transaction) or ` sale,update_payment_token ` (updates the token and processes the transaction). See [Sample Transaction Process Using JSP](/docs/cybs/en-us/sa/developer/all/sa-checkout/secure-acceptance/sa-samples-scripting-languages/sa-sample-txn-process-using-jsp.md ""). You must include the allow_payment_token_update field and set it to ` true `. > Example: Updating a Payment Card Token > **Request** ``` access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 transaction_type=update_payment_token profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 reference_number=1350029885978 payment_token=CF2194C8A0F545CDE053AF598E0A20DA amount=100.00 currency=USD payment_method=card card_type=001 card_number=411111111111xxxx // Replace x with 1 card_expiry_date=12-2022 card_cvn=005 bill_to_forename=Joe bill_to_surname=Smith bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_state=CA bill_to_address_country=US locale=en transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2020-01-17T10:46:39Z consumer_id=x23987456x // Replace x with 1 signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=WrXOhTzhBjYMZROwiCug2My3jiZHOqATimcz5EBA07M= ``` **Response** ``` transaction_id=3500311655560181552946 decision=ACCEPT message=Request was processed successfully. req_access_key=a2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p2 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_transaction_uuid=55d895790bc4c8a0f4464f9426ba3b79 req_transaction_type=authorization,update_payment_token req_reference_number=1350029885978 req_amount=100.00 req_tax_amount=15.00 req_currency=USD req_locale=en req_payment_method=card req_consumer_id=x23987456x // Replace x with 1 req_bill_to_forename=Joe req_bill_to_surname=Smith req_bill_to_email=jsmith@example.com req_bill_to_address_line1=1 My Apartment req_bill_to_address_state=CA req_bill_to_address_country=US req_card_number=xxxxxxxxxxxx1111 req_card_type=001 req_card_expiry_date=12-2022 reason_code=100 auth_avs_code=U auth_avs_code_raw=00 auth_response=0 auth_amount=100.00 auth_time=2022-08-14T134608Z payment_token=CF2194C8A0F545CDE053AF598E0A20DA signed_field_names=comma separated list of signed fields signed_date_time=2022-10-12T08:39:25Z signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= ``` Updating an ACH Token {#sa-update-echeck-token} =============================================== The payment_token field identifies the ACH account and retrieves the associated billing, shipping, and payment information. > Include the endpoint that supports ` update_payment_token ` or the endpoint that supports ` sale,update_payment_token ` (updates the token and processes the transaction). You must include the allow_payment_token_update field and set to true. > Example: Updating an ACH Payment Token > **Request** ``` access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p3 profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 reference_number=1845864013783060468573616 currency=USD amount=100.00 locale=en payment_token=CF2194C8A0F545CDE053AF598E0A20DA transaction_uuid=fcfc212e92d23be881d1299ef3c3b314 signed_date_time=2022-01-17T10:46:39Z signed_field_names=reference_number,transaction_type,currency,amount,locale,payment_method,access_key,profile_id,transaction_uuid,signed_date_time,signed_field_names,unsigned_field_names,etc... unsigned_field_names=comma separated list of unsigned fields signature=jMeHnWRKwU3xtT02j2ufRibfFpbdjUSiuWGT9hnNm00= bill_to_forename=Joe bill_to_surname=Smith bill_to_email=joesmith@example.com bill_to_address_line1=1 My Apartment bill_to_address_state=CA bill_to_address_country=US payment_method=echeck driver_license_state=NY driver_license_number=X4-782X9-X96 // Replace X with 3 date_of_birth=19901001 echeck_account_type=c company_tax_id=12x456789 // Replace X with 3 echeck_sec_code=WEB echeck_account_number=4528941xx //Replace x with 0 echeck_routing_number=6723x2882 //Replace x with 0 ``` **Response** ``` req_driver_license_state=NY req_driver_license_number=xx-xxxxx-xxx req_date_of_birth=19901001 decision=ACCEPT req_bill_to_address_state=CA signed_field_names=comma separated list of signed fields req_payment_method=echeck req_transaction_type=sale,update_payment_token req_echeck_account_type=c signature=NuxlJilx5YbvKoXlt0baB5hUj5gk4+OozqJnyVF390s= req_locale=en reason_code=100 req_bill_to_address_postal_code=94043 req_echeck_account_number=xxxxx4100 req_bill_to_address_line1=1 My Apartment req_echeck_sec_code=WEB req_bill_to_address_city=San Francisco signed_date_time=2022-07-11T15:11:41Z req_currency=USD req_reference_number=1730560013735542024294683 req_echeck_routing_number=xxxxx2882 transaction_id=3735553783662130706689 req_amount=100.00 req_profile_id=0FFEAFFB-8171-4F34-A22D-1CD38A28A384 req_company_tax_id=12x456789 // Replace X with 3 req_transaction_uuid=38f2efe650ea699597d325ecd7432b1c payment_token=CF2194C8A0F545CDE053AF598E0A20DA req_bill_to_surname=Soap req_bill_to_forename=Joe req_bill_to_email=joesoap@yahoo.com req_access_key=e2b0c0d0e0f0g0h0i0j0k0l0m0n0o0p1 ``` RELATED TO THIS PAGE