Override a pay-in transaction status

Available only in the sandbox environment, this endpoint allows overriding the status of a pay-in transaction for testing purposes.

Use this endpoint to simulate different transaction states and test your integration with various scenarios.

Doesn't work if the transaction is already in a final state (approved, refunded, failed, or
rejected — see the status table above; a transaction already expired can still be moved to
approved since expired is not final for pay-ins). Accepts approved, expired, or failed
as the target status.

Error codes for Override Pay In Status

HTTP status	Error code	Description
400	VALIDATION_ERROR	Request validation failed
400	BAD_REQUEST	Failed to parse the request body
401	UNAUTHORIZED	Missing or invalid authorization token
403	FORBIDDEN	You do not have permission to access this resource
404	NOT_FOUND	Pay-in transaction not found
409	INVALID_STATUS_TRANSITION	Unsupported pay-in transaction status transition
500	INTERNAL_ERROR	Unexpected server error

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://api.paypaga.com/oauth2/token

Path Params

Body Params application/jsonRequired

Examples

curl --location 'https://api.paypaga.com/v2/test/transactions/pay-in//status' \ --header 'Content-Type: application/json' \ --data '{ "reason": "Simulate approved state for integration test", "status": "approved", "with_notifications": false }'

{ "approved_on": "2024-08-06T20:12:41Z", "country": "BR", "created_on": "2024-08-06T20:05:41Z", "currency": "BRL", "expired_on": "2024-08-08T12:00:00Z", "expires_at": "2024-08-06T22:10:41Z", "fail_reason": "Insufficient funds", "failed_on": "2024-08-06T20:10:41Z", "fee": 1.5, "initiated_on": "2024-08-06T20:05:40Z", "merchant_order_reference": "ORDER-2026-0001", "merchant_transaction_reference": "TRX-2026-0001", "paid_amount": 90, "payment_method": "top_up", "processing_output": { "customer_name": "João Silva", "document_number": "12345678901" }, "refund_reason": "Customer requested refund", "refunded_on": "2024-08-07T15:30:00Z", "requested_amount": 100, "status": "initiated", "tax": 0.5, "transaction_amount": 98, "transaction_id": "20240806-2010-4086-8342-c28f4979f834", "transaction_input": { "payer_document": "12345678901", "payer_name": "João Silva" }, "unsolicited_payment": false }

Override a pay-in transaction status

Error codes for Override Pay In Status#

Request

Responses

Error codes for Override Pay In Status