PayPaga
  1. Pay Out - Direct API Integration
PayPaga
  • Introduction
    • Introduction
    • API Reference
    • Errors
    • Standard Codes and Values
  • Authorization
    • Authorization
    • OAuth 2.0 Token Generation
  • Pay In - Direct API Integration
    • Pay In - Direct API Integration
    • Pay In - Payment Options
    • Pay In - Payment Processing
    • Pay In - Query Transactions
  • Pay In - PayURL Integration
    • Pay In - PayURL Integration
    • Pay In - Create PayURL
  • Pay Out - Direct API Integration
    • Pay Out - Direct API Integration
    • Pay Out - Query Transactions
      GET
    • Pay Out - Payment Processing
      POST
  • Pay Out - Examples
    • Pay Out - Brazil
    • Pay Out - Mexico
    • Pay Out - Argentina (V2)
    • Pay Out - Colombia (V2)
    • Pay Out - Ecuador (V2)
    • Pay Out - Guatemala (V2)
    • Pay Out - Peru (V2)
  • Transactions Status Notification
    • Transactions Status Notification
  • Query Balance
    • Query Balance
  • Appendix
    • Transaction Status Definitions and Lifecycle
  1. Pay Out - Direct API Integration

Pay Out - Payment Processing

Developing
Develop Env
https://merchant-api.stg.paypaga.com
Develop Env
https://merchant-api.stg.paypaga.com
POST
https://merchant-api.stg.paypaga.com
/payout
Execute individual Pay Out transactions. The merchant_transaction_reference field per individual Pay Out transaction enables individual status notifications and therefore should be unique per individual Pay Out transaction.
Pay Out processing is performed in stages where the configured transaction status notification mechanism is utilized to notify the merchant.
The balance available for Pay Out transactions can be up to 90% of your total successful Pay In transactions. The balance available can be queried using Query Balance.
Request Payloads
For examples of payloads for the individual countries, please see:
Supported on version 1 and 2:
Pay Out - Example - Brazil
Pay Out - Example - Mexico
Supported on version 2+:
Pay Out - Argentina (V2)
Pay Out - Colombia (V2)
Pay Out - Ecuador (V2)
Pay Out - Guatemala (V2)
Pay Out - Peru (V2)
Error codes for Payout Payment Processing
Error CodeDescription
200Transaction limit not configured
201Transaction total exceeds limit per transaction
203Merchant Identifier is missing or is invalid
204Payment method value is not valid. It should be Bank Transfer only (BNKTR)
205Specified country currency is invalid
206Payment configuration not found
210Insufficient funds for transaction
211Missing balance record for merchant
220Merchant configuration not found
221Merchant transaction reference already exists
230Payment reference already exists on processing
235Failed to process transaction
250Bad request for payout transaction
Validation error messages that could be returned:
  • Invalid Transaction Amount
    • "field": "transaction"
    • "message": "Invalid transaction amount."
  • Missing merchant transaction reference
    • "field": "transaction"
    • "message": "Missing required transaction reference."
  • Invalid Counterpart Institution
    • "field": "counterpart institution"
    • "message": "Invalid counterpart entity code."
  • Invalid RFC CURP
    • "field": "rfc curp"
    • "message": "Invalid beneficiary rfc-curp."
  • Invalid Beneficiary Account Type
    • "field": "beneficiary account type"
    • "message": "Invalid beneficiary account type."
  • Invalid Beneficiary Account
    • "field": "beneficiary account"
    • "message": "Invalid beneficiary account."
  • Invalid Pix Key
    • "field": "beneficiary pix key"
    • "message": "Invalid beneficiary pix key."
  • Invalid Beneficiary Name
    • "field": "beneficiary name"
    • "message": "Invalid beneficiary name."
  • Invalid Beneficiary Type
    • "field": "beneficiary type"
    • "message": "Invalid beneficiary type."
  • Invalid Beneficiary Id
    • "field": "beneficiary id"
    • "message": "Invalid beneficiary id."
  • Invalid Beneficiary Id Type
    • "field": "beneficiary id type"
    • "message": "Invalid beneficiary id type."
251Payout processing is disabled at this time, please contact support
500Unexpected error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://merchant-api.stg.paypaga.com/payout' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "merchant_id": "443984c6-849a-413e-853f-1167ca04eb93",
  "country_code": "MX",
  "currency": "MXN",
  "payment_method_code": "BNKTR",
  "transaction": {
    "beneficiary": {
      "beneficiary_name": "Juan Ramon Flores",
      "rfc_curp": "FOAJ001122RX5",
      "beneficiary_email": "jrflores@youremail.com",
      "beneficiary_account": "860000000000000017",
      "beneficiary_account_type": "40",
      "beneficiary_type": "INDIVIDUAL",
      "beneficiary_id": "43278243803",
      "beneficiary_id_type": "",
      "counterpart_institution": "860"
    },
    "transaction_data": {
      "payout_concept": "Payment for services",
      "merchant_transaction_reference": "150262",
      "transaction_total": 100.5
    }
  }
}'
Response Response Example
200 - Success
{
  "datetime": "2024-04-09 18:47:07.960978",
  "message": "Payment processing initiated",
  "details": {
    "result": "success",
    "transaction_processed": {
      "transaction_id": "20240409-1847-0783-90cc-133c988ef5c6",
      "merchant_transaction_reference": "150267"
    }
  },
  "version": "0.1"
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🔴500Server Error
Previous
Pay Out - Query Transactions
Next
Pay Out - Brazil
Built with