PayPal
Create a PayPal payment.
HTTP Request
POST
/v1/payments/charges/paypal
Request Headers
{
"Content-Type": "application/json",
"Authorization": "Bearer {{access_token}}",
"x-api-key": "{{api_key}}"
}
Request Body
{
"idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
"amount": 100,
"currency": "BRL",
"country": "BR",
"paymentMethod": "PAYPAL",
"paymentFlow": "DIRECT",
"payer": {
"name": "Thiago Gabriel",
"email": "thiago@example.com",
"document": {
"documentId": "53012345678",
"type": "CPF"
},
"phone": "+55 81987654321",
"billingAddress": {
"zipCode": "04849333",
"state": "SP",
"city": "sao paulo",
"district": "Jardim Gaivotas",
"street": "Rua 9 de setembro",
"number": "15",
"complement": "casa",
"country": "BR"
}
},
"orderInfo": {
"orderId": "test-order-id",
"shippingInfo": {
"name": "shipping test name",
"phone": "+55 81987654321",
"email": "thiago@example.com",
"address": {
"street": "street name",
"number": "building number",
"complement": "unit, apt, etc.",
"district": "district, neighborhood, etc.",
"city": "city name",
"state": "state, state code",
"zipCode": "zip code, postal code",
"country": "BR"
}
}
},
"callbackUrl": "http://api.client.com/notifications",
"description": "hello world",
"subMerchantId": "UUID"
}
Content-Type: application/json
{
"transferStatusCode": 200,
"transferErrorMsg": null,
"idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
"referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
"paymentMethod": "PAYPAL",
"amount": 100,
"currency": "BRL",
"country": "BR",
"finalAmount": 100,
"finalCurrency": "BRL",
"createTime": "2022-02-20 19:22:32 GMT-08:00",
"scheduledTime": "2022-02-20 21:19:23 GMT-08:00",
"finalStatusTime": null,
"payer": {
"name": "Thiago Gabriel",
"document": {
"documentId": "53012345678",
"type": "CPF"
},
"email": "thiago@example.com",
"phone": "+55 81987654321",
"billingAddress": {
"zipCode": "04849333",
"state": "SP",
"city": "sao paulo",
"district": "Jardim Gaivotas",
"street": "Rua 9 de setembro",
"number": "15",
"complement": "casa",
"country": "BR"
}
},
"transferDetails": {
"paypal": {
"paymentUrl": ""
}
},
"transferStatus": "IN_PROGRESS",
"description": "hello world",
"callbackUrl": "http://api.client.com/notifications",
"subMerchantId": "UUID"
}
Notification / Callback
Content-Type: application/json
{
"eventType": "CHARGE_SUCCEEDED",
"data": {
"chargeDetails": {
"transferStatusCode": 200,
"transferErrorMsg": null,
"idempotencyKey": "1ec983fa-1a37-679b-809b-067861d87ab0",
"referenceId": "1ec983fa-1a37-679b-809b-067861d87ab0",
"paymentMethod": "PAYPAL",
"amount": 100,
"currency": "BRL",
"country": "BR",
"finalAmount": 100,
"finalCurrency": "BRL",
"createTime": "2022-03-01 17:53:18 GMT-08:00",
"scheduledTime": "2022-03-01 17:53:18 GMT-08:00",
"finalStatusTime": null,
"payer": {
"name": "Thiago Gabriel",
"document": {
"documentId": "53012345678",
"type": "CPF"
},
"email": "thiago@example.com",
"phone": "+55 81987654321",
"billingAddress": {
"zipCode": "04849333",
"state": "SP",
"city": "sao paulo",
"district": "Jardim Gaivotas",
"street": "Rua 9 de setembro",
"number": "15",
"complement": "casa",
"country": "BR"
}
},
"transferDetails": {
"paypal": {
"paymentUrl": ""
}
},
"transferStatus": "SETTLED",
"description": "hello world",
"callbackUrl": "http://api.client.com/notifications",
"subMerchantId": "UUID"
}
}
}
HTTP Headers Details
Key | Value |
---|---|
Authorization | "bearer" + " " + {{access_token}} |
x-api-key | {{api_key}} |
Request Body Parameters
Parameter | Required | Type | Description |
---|---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests. given by the merchant in their system. | |
amount | Long | The transfer amount. The minimum settlement granularity of the current currency, such as 100=1BRL | |
country | String | country code | |
currency | String | The currency code of the transferred fund | |
paymentMethod | String | payment method, enum value as PAYPAL. | |
paymentFlow | String | payment flow, enum value as DIRECT or REDIRECT | |
payer | JSON | payer info | |
orderInfo | JSON | order info | |
description | String | description of payment. | |
callbackUrl | String | URL where Liquido will send notifications associated to changes to this payment. will receive a post request. | |
subMerchantId | String | The sub merchant ID. Required for PSPs. | |
riskData | JSON | The risk data of the payment. MERCHANT_APP_NAME or MERCHANT_WEBSITE must be provided in risk Data. Please see here for further details. |
Create A Payment With Risk Data
Please see here for further details.
Payer Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
name | String | fullname(Input specification: Only a combination of uppercase and lowercase letters, numbers and spaces is allowed. Spanish and Portuguese letters, and other special characters are not allowed). | |
String | email. | ||
phone | String | Mobile phone number. Should include “+55” as a prefix. | |
document | JSON | Wallet holder identity proof, such as CPF for Brazil. | |
billingAddress | JSON | Billing address info. |
document Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
documentId | String | identity number | |
type | String | enum of CPF or CNPJ |
billingAddress Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
zipCode | String | zip code. such as CEP in Brazil | |
state | String | state. should be abbreviation, such as SP in Brazil | |
city | String | city name. | |
district | String | district name. | |
street | String | street name. | |
number | String | street number. | |
complement | String | complement info. | |
country | String | country code. |
orderInfo Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
orderId | String | order identity number | |
shippingInfo | JSON | shipping info |
shippingInfo Object Parameters
Parameter | Required | Type | Description |
---|---|---|---|
name | String | shipping name | |
phone | String | Mobile phone number. Should include “+55” as a prefix. | |
String | email address | ||
address | JSON | the same as billingAddress |
Response Body Details
Parameter | Type | Description |
---|---|---|
idempotencyKey | String | Unique key to ensure idempotent requests. given by the merchant in their system |
amount | Long | The transfer amount. The minimum settlement granularity of the current currency, such as 100=1BRL |
country | String | country code |
currency | String | The currency code of the transferred fund |
finalAmount | Long | The final amount that is used for creating the charge order. EX: for charge orders with FX conversion, this field represents the converted amount from the original requested amount. |
finalCurrency | String | The currency code of the finalAmount. |
paymentMethod | String | payment flow, enum value as PAYPAL |
payer | JSON | payer info |
transferDetails | JSON | transaction details info |
description | String | description of payment |
callbackUrl | String | URL where Liquido will send notifications associated to changes to this payment. will receive a post request. |
createdDate | String | Payment ticket created time |
scheduledTime | String | Payment ticket scheduled time |
transferStatus | String | Transfer status, SETTLED, IN_PROGRESS, FAILED |
transferStatusCode | Integer | Transfer status code, 200 transaction SETTLED or IN_PROGRESS, other FAILED |
transferErrorMsg | String | Transfer error message if failed |
subMerchantId | String | The sub merchant ID. |
transferDetails Object Parameters
Parameter | Type | Description |
---|---|---|
paypal | JSON | paypal detail info |
paypal Object Parameters
Parameter | Type | Description |
---|---|---|
paymentUrl | String | link of the payment of paypal |
Transfer Status
Parameter | Description |
---|---|
IN_PROGRESS | The transaction of this method has started, but no transactions have been processed yet. |
SETTLED | The funds of the transaction of this payment have been transferred to the store. |
REFUNDING | The transaction of this payment is refunding. |
REFUNDED | The transaction of this payment method has been refunded. |
CANCELLED | The transaction of this payment has been cancelled. |
FAILED | There was an error while processing the transaction of this payment. This status is followed by a message with more details about the error. |