Retrieve Grant

GET

/v2/grants/:grantId

Retrieves a grant by its ID.

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

grantIdstringRequired

ID of the grant to retrieve.

Created

grantobject

1	import requests
2
3	url = "https://global-api-sandbox.afterpay.com/v2/grants/grantId"
4
5	headers = {"Authorization": "Basic <username>:<password>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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	}