Create PayPal payment

post

https://example.com/api/v1/paymentmethods/paypal/v1/transactions

Create a PayPal transaction. After receiving a HTTP status 201 you have to redirect the consumer to the url given in action.redirect.url. The id field in the response can be used in future calls as transactionId to reference this transaction (for instance in a refund).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create PayPal Transaction

returnUrls

object

required

URLs where the Consumer is redirected to after completing the transaction at its issuing bank or at the chosen payment method.

With this object we can redirect consumer to a dedicated page per payment result status. Either this object or the returnUrl field is mandatory.

reference

string

required

length between 1 and 255

The clients identifier. This value will be sent in the webhook payload alongside the ID you receive as part of the response of a transaction.

amount

integer

required

1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

currency

string

length between 3 and 3

Defaults to EUR

ISO 4217 currency code.

language

string

length between 2 and 2

Preferred language for the user interface as ISO 639-1 code. Commonly supported languages are Dutch (nl) and English (en).

webhooks

array of objects

Array of webhooks that enables receiving a web request once a given event occurs. We won't do preventive rate-limiting in order to have the highest throughput possible. However, we will honor 429 (Too-many-requests) responses per callback. We use the Retry-After header to retry after a certain period. If the header was not set we use our default exponential delay implementation.

webhooks

description

string

required

length ≤ 255

Description of the underlying value or reason of the payment.

expiresAt

date-time

length ≥ 20

ISO 8601 date and time. If a transaction is not finalized before this time the status becomes EXPIRED. If left empty, the value defaults to 6 hours.

consumer

object

required

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The PayPal transaction was created successfully. The response contains the transaction details and a redirect URL to complete the payment.

4XXThe user input was incorrect or something illegal was attempted (eg. using a service without having that service configured for the user, or not being authorized)

5XXInternal server error. This can be caused by an unresponsive backend