API Overview

PPRO
- Recent Revisions
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to PPRO Integration
- Endpoints for the REST API
- Processing a Sale Workflow
- Processing a Sale Using a Bank ID Workflow
- Refunding a Payment Workflow
- Response Statuses Workflow

Alfamart
- Alfamart Sales
  - Alfamart Required Fields for a Sale Using the REST API
  - Alfamart Optional Field
  - Example: Requesting an Alfamart Sale Using the REST API
  - Example: Requesting an Alfamart Kredivo Sale Using the REST API
- Alfamart Retrieve a Transaction
  - Alfamart Fields
  - Example: Requesting an Alfamart Status Using the REST API
  - Example: Requesting an Alfamart Retrieve a Transaction Kredivo Using the REST API
- Alfamart Refunds
  - Alfamart Required Fields
  - Example: Requesting an Alfamart Refund Using the REST API

Bancontact
- Bancontact Sales
  - Bancontact Required Fields
  - Example: Requesting an Bancontact Sale Using the REST API
- Retrieve a Transaction
  - Bancontact Retrieve a Transaction
  - Example: Requesting an Bancontact Status Using the REST API
- Bancontact Refunds
  - Example: Requesting an Bancontact Refund Using the REST API

DOKU
- DOKU Sales
  - DOKU Required Fields
    - DOKU Optional Field
  - Example: Requesting an DOKU Sale Using the REST API
- DOKU Retrieve a Transaction
  - DOKU Required Fields
  - Example: Requesting an DOKU Retrieve a Transaction Using the REST API
- DOKU Refunds
  - DOKU Fields
  - Example: Requesting an DOKU Refund Using the REST API

Dragonpay
- Dragonpay Sales
  - Dragonpay Required Fields
  - Example: Requesting an Dragonpay Sale Using the REST API
- Retrieve a Transaction
  - Required Fields for a Retrieve a Transaction
  - Example: Requesting an Dragonpay Retrieve a Transaction Using the REST API
- Dragonpay Refunds
  - Dragonpay Required Fields
  - Example: Requesting an Dragonpay Refund Using the REST API

eNets
- eNets Sales
  - eNETS Required Fields
  - Example: Requesting an eNets Sale Using the REST API

EPS
- EPS Sales
  - EPS Required Fields
  - Example: Requesting an EPS Sale Using the REST API
- EPS Refunds
  - EPS Fields
  - Example: Requesting an EPS Refund Using the REST API

Estonia Banks
- Retrieve Bank Options
  - Required Fields for Options Using the REST API
  - Example: Retrieving Bank Options
- Estonia Banks Sales
  - Estonia Banks Required Fields
    - Estonia Banks Optional Field
  - Example: Requesting an Estonia Banks Sale Using the REST API
- Retrieve a Transaction
  - Required Fields for a Retrieve a Transaction
  - Example: Requesting an Estonia Banks Retrieve a Transaction Using the REST API
- Estonia Banks Refunds
  - Estonia Banks Required Fields
  - Example: Requesting an Estonia Banks Refund Using the REST API

FPX Online Banking
- FPX Online Banking Sales
  - FPX Online Banking Required Fields
    - FPX Online Banking Optional Field
  - Example: Requesting an FPX Online Banking Sale Using the REST API
- FPX Refunds
  - FPX Fields
  - Example: Requesting an FPX Refund Using the REST API

GrabPay
- GrabPay Sales
  - GrabPay Required Fields
  - Example: Requesting an GrabPay Sale Using the REST API

iDEAL
- Process a Sale
  - Required Fields for Processing a Sale
  - Optional Fields for Processing a Sale
  - Example: Requesting an iDEAL Sale
- Retrieve a Transaction
  - Example: Requesting an iDEAL Retrieve a Transaction
- Refund a Payment
  - Required Fields for Refunding a Payment
  - Optional Fields for Refunding a Payment
  - Example: Requesting an iDEAL Refund

Indomaret
- Indomaret Sales
  - Indomaret Fields
    - Indomaret Optional Field
  - Example: Requesting an Indomaret Sale Using the REST API

Indonesia Banks
- Indonesia Banks Sales
  - Indonesia Banks Fields
    - Indonesia Optional Field
  - Example: Requesting an Indonesia Banks Sale Using the REST API
- Indonesia Banks Retrieve a Transaction
  - Indonesia Banks Fields
  - Example: Requesting an Indonesia Banks Retrieve a Transaction Using the REST API
- Indonesia Banks Refunds
  - Indonesia Banks Fields
  - Example: Requesting an Indonesia Banks Refund Using the REST API

Jenius Pay
- Jenius Pay Sales
  - Jenius Pay Fields
    - Jenius Pay Optional Field
  - Example: Requesting an Jenius Pay Sale Using the REST API
- Retrieve a Transaction
  - Jenius Pay Fields
  - Example: Requesting an Jenius Pay Retrieve a Transaction Using the REST API
- Jenius Pay Refunds
  - Jenius Pay Fields
  - Example: Requesting an Jenius Pay Refund Using the REST API

Konbini
- Konbini Sales
  - Konbini Required Fields
  - Example: Requesting an Konbini Sale Using the REST API
- Retrieve a Transaction
  - Konbini Required Fields
  - Example: Requesting an Konbini Retrieve a Transaction Using the REST API

Latvia Banks
- Retrieve Bank Options
  - Required Fields for Options Using the REST API
  - Example: Retrieving Bank Options
- Latvia Banks Sales
  - Latvia Banks Required Fields
    - Latvia Banks Optional Field
  - Example: Requesting an Latvia Banks Sale Using the REST API
- Retrieve a Transaction
  - Latvia Banks Required Fields
  - Example: Requesting an Latvia Banks Retrieve a Transaction Using the REST API
- Latvia Banks Refunds
  - Latvia Banks Required Fields
  - Example: Requesting an Latvia Banks Refund Using the REST API

LinkAja
- LinkAja Sales
  - LinkAja Fields
    - LinkAja Optional Field
  - Example: Requesting a LinkAja Sale Using the REST API
  - Example: Requesting an LinkAja Airline Sale Using the REST API
  - Example: Requesting an LinkAja Kredivo Sale Using the REST API
- Retrieve a Transaction
  - LinkAja Fields
  - Example: Requesting an LinkAja Kredivo Retrieve a Transaction Using the REST API
  - Example: Requesting an LinkAja Retrieve a Transaction Using the REST API
- LinkAja Refunds
  - LinkAja Fields
  - Example: Requesting a LinkAja Refund Using the REST API

Lithuania Banks
- Retrieve Bank Options
  - Required Fields for Options Using the REST API
  - Example: Retrieving Bank Options
- Lithuania Banks Sales
  - Lithuania Banks Required Fields
    - Lithuania Banks Optional Field
  - Example: Retrieving Bank Options
- Retrieve a Transaction
  - Lithuania Banks Required Fields
  - Example: Requesting an Lithuania Banks Retrieve a Transaction Using the REST API
- Lithuania Banks Refunds
  - Lithuania Banks Required Fields
  - Example: Requesting an Lithuania Banks Refund Using the REST API

Multibanco
- Multibanco Sales
  - Multibanco Required Fields
  - Example: Requesting an Multibanco Sale Using the REST API
- Multibanco Refunds
  - Multibanco Required Fields
  - Example: Requesting an Multibanco Refund Using the REST API

MyBank
- MyBank Sales
  - MyBank Required Fields
  - Example: Requesting an MyBank Sale Using the REST API
- Retrieve a Transaction
  - MyBank Retrieve a Transaction
  - Example: Requesting an MyBank Retrieve a Transaction Using the REST API
- MyBank Refunds
  - MyBank Required Fields
  - Example: Requesting an MyBank Refund Using the REST API

OVO
- OVO Sales
  - OVO Fields
    - OVO Optional Field
  - Example: Requesting an OVO Sale Using the REST API
- Retrieve a Transaction
  - OVO Retrieve a Transaction
  - Example: Requesting an OVO Retrieve Transaction Using the REST API

Payconiq
- Payconiq Sales
  - Payconiq Required Fields
  - Example: Requesting an Payconiq Sale Using the REST API
- Payconiq Refunds
  - Payconiq Required Fields
  - Example: Requesting an Payconiq Refund Using the REST API

Pay-easy
- Pay-easy Sales
  - Pay-easy Required Fields
  - Example: Requesting an Pay-easy Sale Using the REST API
- Pay-easy
  - Pay-easy Retrieve a Transaction
  - Example: Requesting an Pay-easy Retrieve a Transaction Using the REST API

PayU
- PayU Sales
  - PayU Required Fields
  - Example: Requesting an PayU Sale Using the REST API
- Retrieve a Transaction
  - PayU Retrieve a Transaction
  - Example: Requesting an PayU Retrieve a Transaction Using the REST API
- PayU Refunds
  - PayU Required Fields
  - Example: Requesting an PayU Refund Using the REST API

Przelewy24
- Retrieve Bank Options
  - Required Fields for Options Using the REST API
  - Example: Retrieving Bank Options
- Przelewy24 Sales
  - Przelewy24 Required Fields
    - Przelewy24 Optional Fields
  - Example: Requesting an Przelewy24 Sale Using the REST API
- Przelewy24 Refunds
  - Przelewy24 Required Fields
  - Example: Requesting an Przelewy24 Refund Using the REST API

7-Eleven
- 7-Eleven Sales
  - 7-Eleven Malaysia Cash Required Fields
  - Example: Requesting an 7-Eleven Sale Using the REST API

Thailand Bank
- Thailand Banks Sales
  - Thailand Banks Required Fields
    - Thailand Banks Optional Field
  - Example: Requesting an Thailand Banks Sale Using the REST API

Trustly
- Trustly Sales
  - Trustly Required Fields
    - Trusty Optional Fields
  - Example: Requesting an Trustly Banks Sale Using the REST API
- Retrieve a Transaction
  - Trustly Retrieve a Transaction
  - Example: Requesting an Trustly Retrieve a Transaction Using the REST API
- Trustly Refunds
  - Trustly Required Fields
  - Example: Requesting an Trustly Refund Using the REST API

TrustPay
- TrustPay Sales
  - TrustPay Required Fields
  - Example: Requesting an TrustPay Sale Using the REST API

REST API Field Reference Section
- merchantinformation.successURL
- paymentInformation.bank.account.name
- paymentinformation.bank.account.number
- paymentinformation.bank.code
- paymentinformation.bank.iban
- paymentinformation.bank.name
- paymentinformation.bank.swiftcode
- paymentOptions.resources[].id
- paymentInformation.paymentType.method.type
- paymentInformation.purposeOfPayment
- processingInformation.transactionTimeout

On This Page

Process a Sale

This section describes how to process an iDEAL sale.

A successful sale request includes an iDEAL redirect URL in the response. You must redirect the customer to this URL in order for the customer to complete the payment using their iDEAL account. If the customer does not complete the payment within 60 minutes of the URL being generated, the URL will expire and the sale's status updates to

FAILED

. If the URL expires, send a new sale request to complete the payment.

Shipping Information

Cybersource recommends that you do not ship purchased items until the sale is in the completed status.

Endpoints

Production:

POST https://api.cybersource.com/pts/v2/payments

Test:

POST https://apitest.cybersource.com/pts/v2/payments

Response Statuses

Cybersource

responds to your request with one of these possible statuses in the

status

response field.

PENDING

: The request is successful and is currently processing. Redirect the customer to the payment method's URL in the response in order for the customer to complete the payment. Send periodic retrieve a transaction requests until the status updates.

FAILED

: The request is not successful due to the PPRO supported payment method declining the request. Send a new sale request.

INVALID_REQUEST

: The request is not successful due to invalid information in the request. Send a new sale request.

SERVER_ERROR

: The request is not successful due to a system timeout error. Resend the sale request.

Back to top