Retrieve Grant

GET

/v2/grants/:grantId

Retrieves a grant based on its ID.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

grantIdstringRequired

ID of the grant to retrieve.

Created

grantobject

403

Forbidden Error

404

Not Found Error

1	{
2	"grant": {
3	"id": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
4	"type": "ON_FILE",
5	"status": "ACTIVE",
6	"created": "2024-03-04T12:00:00Z",
7	"merchantReference": "merchant_ref_123",
8	"cancelled": "2024-03-05T12:00:00Z",
9	"expires": "2025-03-04T12:00:00Z",
10	"consumerReference": "cust_12345",
11	"email": "j*@e*.com",
12	"requestId": "req_abc123def456"
13	}
14	}

1	curl https://global-api-sandbox.afterpay.com/v2/grants/grantId \
2	-H "User-Agent: User-Agent" \
3	-u "<username>:<password>"