docs.agile4pay.com Open in urlscan Pro
35.174.179.138  Public Scan

URL: https://docs.agile4pay.com/
Submission: On February 09 via api from US — Scanned from US

Form analysis 0 forms found in the DOM

Text Content

 * Body
 * Headers (19)

 * Body
 * Headers (20)

 * Body
 * Headers (20)

 * Body
 * Headers (20)




Public


Documentation Settings

ENVIRONMENT
Agile Local Env

LAYOUT
Double Column

LANGUAGE
cURL - cURL



Agile4Pay
Introduction
PIX
CARD
BANK


AGILE4PAY

API collection for AgilePay

AUTHORIZATIONAPI Key
Key

Authorization

Value

Basic PROD_I2FryfnDQD7uwK0kmRDeESEgXRm705ZyH2R


PIX

Transactions related to PIX

AUTHORIZATIONAPI Key
This folder is using API Key from collectionAgile4Pay



POSTCASHOUT


https://api.agile4pay.com/api:6hW02nYt/pix/cashout

Webhook example data:

Plain Text


{
  "identifier": "E00694877202401182141rqWIX9QgfR9",
  "protocol": "abc123456h",
  "status": "SENT",
  "amount": 0.1,
  "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8"
}

AUTHORIZATIONAPI Key
This request is using API Key from collectionAgile4Pay
Bodyraw (json)
json


{

    "amount": 0.01,
    "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8",
    "type":"PIX",
    "pixKey":"email",
    "pixValue":"bruno@2signer.com",
    "protocol":"c5023886-536f-4904-8719-152ac3168efb"


}

Example Request
cashout

View More
curl


curl --location 'https://api.agile4pay.com/api:6hW02nYt/pix/cashout' \
--header 'Authorization: Basic PROD_48dsiXsWZXGYjQbNJnBXuBfMMN5Vbtce0SC' \
--data-raw '{

    "amount": 0.02,
    "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8",
    "type":"PIX",
    "pixKey":"email",
    "pixValue":"bruno@2signer.com",
    "protocol":"a8536eaf-9025-4487-b8e4-71123acd066a"


}'

200 OK
Example Response
 * Body
 * Headers (19)

json


{
  "protocol": "abc123456h",
  "identifier": "E006948772024011819573oMagyQ4sxh",
  "status": "PROCESSING"
}

Date

Thu, 18 Jan 2024 19:57:07 GMT

Content-Type

application/json; charset=UTF-8

Transfer-Encoding

chunked

Connection

keep-alive

Set-Cookie

XNS=35865238c223dd0fe9fac961a544437f|207498c3182d235365ac99a6364a3472;
Path=/socket/; Secure; HttpOnly; SameSite=Strict

X-App

hit

X-XSS-Protection

1; mode=block

Cache-Control

private, no-cache, no-store, must-revalidate

Pragma

no-cache

Expires

Mon, 20 Jan 2014 19:57:05 GMT

X-Content-Type-Options

nosniff

X-Frame-Options

deny

Access-Control-Allow-Origin

*

Access-Control-Allow-Methods

GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD

Access-Control-Allow-Headers

*

Access-Control-Allow-Credentials

true

Access-Control-Max-Age

86400

Content-Encoding

gzip

Strict-Transport-Security

max-age=31536000; includeSubDomains;


GETCASHOUT


https://api.agile4pay.com/api:6hW02nYt/pix/cashout/:protocol
AUTHORIZATIONAPI Key
This request is using API Key from collectionAgile4Pay
PATH VARIABLES
protocol

c001642d-fc4b-4f24-83d4-78256f0567b2

Example Request
cashout

curl


curl --location 'https://api.agile4pay.com/api:6hW02nYt/pix/cashout/abc123456h' \
--header 'Authorization: Basic PROD_48dsiXsWZXGYjQbNJnBXuBfMMN5Vbtce0SC'

200 OK
Example Response
 * Body
 * Headers (20)

json


{
  "amount": "0.10",
  "date": "2024-01-18T18:51:09.635Z",
  "pixKey": "telefone",
  "pixValue": "61995053338",
  "status": "PAID"
}

Date

Thu, 18 Jan 2024 19:27:10 GMT

Content-Type

application/json; charset=UTF-8

Transfer-Encoding

chunked

Connection

keep-alive

Set-Cookie

XNS=47a08bc82e06b57cc9b7377505dec39f|207498c3182d235365ac99a6364a3472;
Path=/socket/; Secure; HttpOnly; SameSite=Strict

X-App

miss

X-Workspace

miss

X-XSS-Protection

1; mode=block

Cache-Control

private, no-cache, no-store, must-revalidate

Pragma

no-cache

Expires

Mon, 20 Jan 2014 19:27:10 GMT

X-Content-Type-Options

nosniff

X-Frame-Options

deny

Access-Control-Allow-Origin

*

Access-Control-Allow-Methods

GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD

Access-Control-Allow-Headers

*

Access-Control-Allow-Credentials

true

Access-Control-Max-Age

86400

Content-Encoding

gzip

Strict-Transport-Security

max-age=31536000; includeSubDomains;


GETCASHIN


https://api.agile4pay.com/api:6hW02nYt/pix/cashin/:protocol
AUTHORIZATIONAPI Key
This request is using API Key from collectionAgile4Pay
PATH VARIABLES
protocol

fc475810-32da-444a-a32b-84a83a30a9df

Example Request
cashin

View More
curl


curl --location 'https://api.agile4pay.com/api:6hW02nYt/pix/cashin/abc123xyzsdfxcvb1234' \
--header 'Authorization: Basic PROD_48dsiXsWZXGYjQbNJnBXuBfMMN5Vbtce0SC'

200 OK
Example Response
 * Body
 * Headers (20)

View More
json


{
  "status": "PENDING",
  "amount": 0.1,
  "identifier": "B7IF3JBJ3BOH9S2OVEXR8OHGDWTG122PRZ",
  "emv": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/1e4865f0-d0da-4f97-b868-f37676e908cf5204000053039865802BR5919BRUNO DE SOUZA REGO6013Nao_informado62070503***630403B4",
  "protocol": "abc123xyzsdfxcvb1234",
  "createdDate": "2024-01-18T19:27:48.404Z"
}

Date

Thu, 18 Jan 2024 19:56:35 GMT

Content-Type

application/json; charset=UTF-8

Transfer-Encoding

chunked

Connection

keep-alive

Set-Cookie

XNS=35865238c223dd0fe9fac961a544437f|207498c3182d235365ac99a6364a3472;
Path=/socket/; Secure; HttpOnly; SameSite=Strict

X-App

miss

X-Workspace

miss

X-XSS-Protection

1; mode=block

Cache-Control

private, no-cache, no-store, must-revalidate

Pragma

no-cache

Expires

Mon, 20 Jan 2014 19:56:35 GMT

X-Content-Type-Options

nosniff

X-Frame-Options

deny

Access-Control-Allow-Origin

*

Access-Control-Allow-Methods

GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD

Access-Control-Allow-Headers

*

Access-Control-Allow-Credentials

true

Access-Control-Max-Age

86400

Content-Encoding

gzip

Strict-Transport-Security

max-age=31536000; includeSubDomains;


POSTCASHIN


https://api.agile4pay.com/api:6hW02nYt/pix/cashin
Plain Text


Webhook example data:
{
  "identifier": "B1V45Q5LJ3Z9DI9QW011CTJJ75I3AFLA6P",
  "protocol": "abcsd6666",
  "status": "RECEIVED",
  "amount": 15,
  "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8"
}

AUTHORIZATIONAPI Key
This request is using API Key from collectionAgile4Pay
Bodyraw (json)
json


{
    "amount": 1,
    "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8",
    "expiration": 604800,
    "protocol": "886721ad-a09b-4203-b587-d9c1bfcfd7fa",
    "payer_name": "Bruno",
    "payer_documento": "0457742046599"
}


Example Request
cashin

curl


curl --location 'https://api.agile4pay.com/api:6hW02nYt/pix/cashin' \
--header 'Authorization: Basic PROD_48dsiXsWZXGYjQbNJnBXuBfMMN5Vbtce0SC' \
--data '{
    "amount": 1,
    "webhook": "https://webhook.site/1e91c52c-db29-4c38-8afc-38b3215bf1a8",
    "expiration": 360,
     "protocol":"3ab096ae-d8de-46b5-9fd1-ead7ba4c66fd"
}'

200 OK
Example Response
 * Body
 * Headers (20)

View More
json


{
  "protocol": "abc123xyzsdfxcvb1234",
  "emv": "00020101021226900014br.gov.bcb.pix2568pix.sicoob.com.br/qr/payload/v2/e959b276-9be2-46ec-a267-717fba2b8cb05204000053039865802BR5919BRUNO DE SOUZA REGO6013Nao_informado62070503***63045451",
  "identifier": "7PP3MHNYNJ5N357Y6YOEZ51RMVV754DHEF"
}

Date

Thu, 18 Jan 2024 19:39:02 GMT

Content-Type

application/json; charset=UTF-8

Transfer-Encoding

chunked

Connection

keep-alive

Set-Cookie

XNS=35865238c223dd0fe9fac961a544437f|207498c3182d235365ac99a6364a3472;
Path=/socket/; Secure; HttpOnly; SameSite=Strict

X-App

miss

X-Workspace

miss

X-XSS-Protection

1; mode=block

Cache-Control

private, no-cache, no-store, must-revalidate

Pragma

no-cache

Expires

Mon, 20 Jan 2014 19:39:00 GMT

X-Content-Type-Options

nosniff

X-Frame-Options

deny

Access-Control-Allow-Origin

*

Access-Control-Allow-Methods

GET, POST, DELETE, PUT, PATCH, OPTIONS, HEAD

Access-Control-Allow-Headers

*

Access-Control-Allow-Credentials

true

Access-Control-Max-Age

86400

Content-Encoding

gzip

Strict-Transport-Security

max-age=31536000; includeSubDomains;