Refund a succeeded payment

POST

/refunds

const url = 'https://api.pachapay.io/v1/refunds';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'example',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"payment_id":"example","amount":1,"destination":{"type":"bank_account","bank_code":"example","account_number":"example","account_type":"checking","holder_name":"example","holder_document":{"type":"RUT","number":"example"}},"reason":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.pachapay.io/v1/refunds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "payment_id": "example", "amount": 1, "destination": { "type": "bank_account", "bank_code": "example", "account_number": "example", "account_type": "checking", "holder_name": "example", "holder_document": { "type": "RUT", "number": "example" } }, "reason": "example" }'

Card payments are refunded through the provider. Other families are refunded as a payout to the payer’s account, so destination is required for them. Our fee is not returned by default. Requires enough available balance, otherwise 422 insufficient_balance.

Authorizations

ApiKey

Parameters

Header Parameters

Idempotency-Key

required

string

<= 255 characters

Unique key per logical operation, up to 255 characters. Keys are kept for 24 hours. Same key with a different body returns 409 idempotency_conflict, and the same key while the first request is still running returns 409 idempotency_in_progress.

Request Body^required

application/json

object

payment_id

required

string

/^pay_/

amount

Minor units. Omit for a full refund.

integer format: int64

>= 1

destination

One of: discriminator: type

Bank account

object

type

required

string

Allowed value: bank_account

bank_code

string

account_number

required

string

account_type

string

Allowed values: checking savings vista other

holder_name

required

string

holder_document

required

object

type

required

string

Allowed values: RUT CC NIT CE PASS PPT RUC DL DNI CPP CPF CNPJ RFC CURP

number

required

string

reason

string

<= 500 characters

Responses

201

Refund created.

application/json

object

required

string

object

required

string

Allowed value: refund

status

required

string

Allowed values: created processing succeeded failed canceled returned

payment_id

required

string

payout_id

Set when the refund is executed as a payout.

string | null

amount

required

integer format: int64

currency

required

ISO 4217 code. Crypto assets are not accepted in this field.

string

Allowed values: CLP COP PEN MXN BRL USD

reason

string | null

created_at

required

string format: date-time

Example

{
  "id": "ref_0192f3c2",
  "object": "refund",
  "status": "created",
  "currency": "CLP"
}

4XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

Stable machine-readable code that does not change within a major version. Examples are parameter_invalid, parameter_missing, amount_out_of_range, api_key_invalid, api_key_revoked, merchant_not_active, method_not_allowed, country_not_allowed, resource_not_found, idempotency_conflict, idempotency_in_progress, invalid_state, insufficient_balance, method_not_available, blocked_payer, limit_exceeded, rate_limited, internal_error, provider_unavailable, service_unavailable.

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}

5XX

Error. See error.code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error invalid_state_error idempotency_error rate_limit_error api_error

code

required

string

message

required

string

param

Name of the offending parameter, if any.

string

request_id

required

string

Examples

Merchant not approved

{
  "error": {
    "type": "permission_error",
    "code": "merchant_not_active",
    "message": "KYB is not approved for this merchant.",
    "request_id": "req_01"
  }
}

Not enough balance

{
  "error": {
    "type": "invalid_state_error",
    "code": "insufficient_balance",
    "message": "Available balance is lower than the amount plus fee.",
    "param": "amount",
    "request_id": "req_02"
  }
}

Refund a succeeded payment

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

4XX

Examples

5XX

Examples

Request Body^required